3 * Implements Special:Newpages
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
25 * A special page that list newly created pages
27 * @ingroup SpecialPage
29 class SpecialNewpages
extends IncludableSpecialPage
{
34 protected $customFilters;
36 protected $showNavigation = false;
38 public function __construct() {
39 parent
::__construct( 'Newpages' );
42 protected function setup( $par ) {
43 $opts = new FormOptions();
44 $this->opts
= $opts; // bind
45 $opts->add( 'hideliu', false );
46 $opts->add( 'hidepatrolled', $this->getUser()->getBoolOption( 'newpageshidepatrolled' ) );
47 $opts->add( 'hidebots', false );
48 $opts->add( 'hideredirs', true );
49 $opts->add( 'limit', $this->getUser()->getIntOption( 'rclimit' ) );
50 $opts->add( 'offset', '' );
51 $opts->add( 'namespace', '0' );
52 $opts->add( 'username', '' );
53 $opts->add( 'feed', '' );
54 $opts->add( 'tagfilter', '' );
55 $opts->add( 'invert', false );
56 $opts->add( 'size-mode', 'max' );
57 $opts->add( 'size', 0 );
59 $this->customFilters
= [];
60 Hooks
::run( 'SpecialNewPagesFilters', [ $this, &$this->customFilters
] );
61 foreach ( $this->customFilters
as $key => $params ) {
62 $opts->add( $key, $params['default'] );
65 $opts->fetchValuesFromRequest( $this->getRequest() );
67 $this->parseParams( $par );
70 $opts->validateIntBounds( 'limit', 0, 5000 );
73 protected function parseParams( $par ) {
74 $bits = preg_split( '/\s*,\s*/', trim( $par ) );
75 foreach ( $bits as $bit ) {
76 if ( $bit === 'shownav' ) {
77 $this->showNavigation
= true;
79 if ( $bit === 'hideliu' ) {
80 $this->opts
->setValue( 'hideliu', true );
82 if ( $bit === 'hidepatrolled' ) {
83 $this->opts
->setValue( 'hidepatrolled', true );
85 if ( $bit === 'hidebots' ) {
86 $this->opts
->setValue( 'hidebots', true );
88 if ( $bit === 'showredirs' ) {
89 $this->opts
->setValue( 'hideredirs', false );
91 if ( is_numeric( $bit ) ) {
92 $this->opts
->setValue( 'limit', intval( $bit ) );
96 if ( preg_match( '/^limit=(\d+)$/', $bit, $m ) ) {
97 $this->opts
->setValue( 'limit', intval( $m[1] ) );
99 // PG offsets not just digits!
100 if ( preg_match( '/^offset=([^=]+)$/', $bit, $m ) ) {
101 $this->opts
->setValue( 'offset', intval( $m[1] ) );
103 if ( preg_match( '/^username=(.*)$/', $bit, $m ) ) {
104 $this->opts
->setValue( 'username', $m[1] );
106 if ( preg_match( '/^namespace=(.*)$/', $bit, $m ) ) {
107 $ns = $this->getLanguage()->getNsIndex( $m[1] );
108 if ( $ns !== false ) {
109 $this->opts
->setValue( 'namespace', $ns );
116 * Show a form for filtering namespace and username
120 public function execute( $par ) {
121 $out = $this->getOutput();
124 $this->outputHeader();
126 $this->showNavigation
= !$this->including(); // Maybe changed in setup
127 $this->setup( $par );
129 $this->addHelpLink( 'Help:New pages' );
131 if ( !$this->including() ) {
135 $feedType = $this->opts
->getValue( 'feed' );
137 $this->feed( $feedType );
142 $allValues = $this->opts
->getAllValues();
143 unset( $allValues['feed'] );
144 $out->setFeedAppendQuery( wfArrayToCgi( $allValues ) );
147 $pager = new NewPagesPager( $this, $this->opts
);
148 $pager->mLimit
= $this->opts
->getValue( 'limit' );
149 $pager->mOffset
= $this->opts
->getValue( 'offset' );
151 if ( $pager->getNumRows() ) {
153 if ( $this->showNavigation
) {
154 $navigation = $pager->getNavigationBar();
156 $out->addHTML( $navigation . $pager->getBody() . $navigation );
158 $out->addWikiMsg( 'specialpage-empty' );
162 protected function filterLinks() {
164 $showhide = [ $this->msg( 'show' )->escaped(), $this->msg( 'hide' )->escaped() ];
166 // Option value -> message mapping
168 'hideliu' => 'rcshowhideliu',
169 'hidepatrolled' => 'rcshowhidepatr',
170 'hidebots' => 'rcshowhidebots',
171 'hideredirs' => 'whatlinkshere-hideredirs'
173 foreach ( $this->customFilters
as $key => $params ) {
174 $filters[$key] = $params['msg'];
177 // Disable some if needed
178 if ( !User
::groupHasPermission( '*', 'createpage' ) ) {
179 unset( $filters['hideliu'] );
181 if ( !$this->getUser()->useNPPatrol() ) {
182 unset( $filters['hidepatrolled'] );
186 $changed = $this->opts
->getChangedValues();
187 unset( $changed['offset'] ); // Reset offset if query type changes
189 // wfArrayToCgi(), called from LinkRenderer/Title, will not output null and false values
190 // to the URL, which would omit some options (T158504). Fix it by explicitly setting them
192 // Also do this only for boolean options, not eg. namespace or tagfilter
193 foreach ( $changed as $key => $value ) {
194 if ( array_key_exists( $key, $filters ) ) {
195 $changed[$key] = $changed[$key] ?
'1' : '0';
199 $self = $this->getPageTitle();
200 $linkRenderer = $this->getLinkRenderer();
201 foreach ( $filters as $key => $msg ) {
202 $onoff = 1 - $this->opts
->getValue( $key );
203 $link = $linkRenderer->makeLink(
205 new HtmlArmor( $showhide[$onoff] ),
207 [ $key => $onoff ] +
$changed
209 $links[$key] = $this->msg( $msg )->rawParams( $link )->escaped();
212 return $this->getLanguage()->pipeList( $links );
215 protected function form() {
216 $out = $this->getOutput();
219 $this->opts
->consumeValue( 'offset' ); // don't carry offset, DWIW
220 $namespace = $this->opts
->consumeValue( 'namespace' );
221 $username = $this->opts
->consumeValue( 'username' );
222 $tagFilterVal = $this->opts
->consumeValue( 'tagfilter' );
223 $nsinvert = $this->opts
->consumeValue( 'invert' );
225 $size = $this->opts
->consumeValue( 'size' );
226 $max = $this->opts
->consumeValue( 'size-mode' ) === 'max';
228 // Check username input validity
229 $ut = Title
::makeTitleSafe( NS_USER
, $username );
230 $userText = $ut ?
$ut->getText() : '';
234 'type' => 'namespaceselect',
235 'name' => 'namespace',
236 'label-message' => 'namespace',
237 'default' => $namespace,
242 'label-message' => 'invert',
243 'default' => $nsinvert,
244 'tooltip' => 'invert',
247 'type' => 'tagfilter',
248 'name' => 'tagfilter',
249 'label-raw' => $this->msg( 'tag-filter' )->parse(),
250 'default' => $tagFilterVal,
254 'name' => 'username',
255 'label-message' => 'newpages-username',
256 'default' => $userText,
257 'id' => 'mw-np-username',
261 'type' => 'sizefilter',
263 'default' => -$max * $size,
267 $htmlForm = HTMLForm
::factory( 'ooui', $formDescriptor, $this->getContext() );
269 // Store query values in hidden fields so that form submission doesn't lose them
270 foreach ( $this->opts
->getUnconsumedValues() as $key => $value ) {
271 $htmlForm->addHiddenField( $key, $value );
276 ->setFormIdentifier( 'newpagesform' )
277 // The form should be visible on each request (inclusive requests with submitted forms), so
278 // return always false here.
284 ->setSubmitText( $this->msg( 'newpages-submit' )->text() )
285 ->setWrapperLegend( $this->msg( 'newpages' )->text() )
286 ->addFooterText( Html
::rawElement(
292 $out->addModuleStyles( 'mediawiki.special' );
296 * @param stdClass $result Result row from recent changes
297 * @param Title $title
298 * @return bool|Revision
300 protected function revisionFromRcResult( stdClass
$result, Title
$title ) {
301 return new Revision( [
302 'comment' => CommentStore
::getStore()->getComment( 'rc_comment', $result )->text
,
303 'deleted' => $result->rc_deleted
,
304 'user_text' => $result->rc_user_text
,
305 'user' => $result->rc_user
,
306 'actor' => $result->rc_actor
,
311 * Format a row, providing the timestamp, links to the page/history,
312 * size, user links, and a comment
314 * @param object $result Result row
317 public function formatRow( $result ) {
318 $title = Title
::newFromRow( $result );
320 // Revision deletion works on revisions,
321 // so cast our recent change row to a revision row.
322 $rev = $this->revisionFromRcResult( $result, $title );
325 $attribs = [ 'data-mw-revid' => $result->rev_id
];
327 $lang = $this->getLanguage();
328 $dm = $lang->getDirMark();
330 $spanTime = Html
::element( 'span', [ 'class' => 'mw-newpages-time' ],
331 $lang->userTimeAndDate( $result->rc_timestamp
, $this->getUser() )
333 $linkRenderer = $this->getLinkRenderer();
334 $time = $linkRenderer->makeKnownLink(
336 new HtmlArmor( $spanTime ),
338 [ 'oldid' => $result->rc_this_oldid
]
341 $query = $title->isRedirect() ?
[ 'redirect' => 'no' ] : [];
343 $plink = $linkRenderer->makeKnownLink(
346 [ 'class' => 'mw-newpages-pagename' ],
349 $histLink = $linkRenderer->makeKnownLink(
351 $this->msg( 'hist' )->text(),
353 [ 'action' => 'history' ]
355 $hist = Html
::rawElement( 'span', [ 'class' => 'mw-newpages-history' ],
356 $this->msg( 'parentheses' )->rawParams( $histLink )->escaped() );
358 $length = Html
::rawElement(
360 [ 'class' => 'mw-newpages-length' ],
361 $this->msg( 'brackets' )->rawParams(
362 $this->msg( 'nbytes' )->numParams( $result->length
)->escaped()
366 $ulink = Linker
::revUserTools( $rev );
367 $comment = Linker
::revComment( $rev );
369 if ( $this->patrollable( $result ) ) {
370 $classes[] = 'not-patrolled';
373 # Add a class for zero byte pages
374 if ( $result->length
== 0 ) {
375 $classes[] = 'mw-newpages-zero-byte-page';
379 if ( isset( $result->ts_tags
) ) {
380 list( $tagDisplay, $newClasses ) = ChangeTags
::formatSummaryRow(
385 $classes = array_merge( $classes, $newClasses );
390 # Display the old title if the namespace/title has been changed
392 $oldTitle = Title
::makeTitle( $result->rc_namespace
, $result->rc_title
);
394 if ( !$title->equals( $oldTitle ) ) {
395 $oldTitleText = $oldTitle->getPrefixedText();
396 $oldTitleText = Html
::rawElement(
398 [ 'class' => 'mw-newpages-oldtitle' ],
399 $this->msg( 'rc-old-title' )->params( $oldTitleText )->escaped()
403 $ret = "{$time} {$dm}{$plink} {$hist} {$dm}{$length} {$dm}{$ulink} {$comment} "
404 . "{$tagDisplay} {$oldTitleText}";
406 // Let extensions add data
407 Hooks
::run( 'NewPagesLineEnding', [ $this, &$ret, $result, &$classes, &$attribs ] );
408 $attribs = array_filter( $attribs,
409 [ Sanitizer
::class, 'isReservedDataAttribute' ],
413 if ( count( $classes ) ) {
414 $attribs['class'] = implode( ' ', $classes );
417 return Html
::rawElement( 'li', $attribs, $ret ) . "\n";
421 * Should a specific result row provide "patrollable" links?
423 * @param object $result Result row
426 protected function patrollable( $result ) {
427 return ( $this->getUser()->useNPPatrol() && !$result->rc_patrolled
);
431 * Output a subscription feed listing recent edits to this page.
433 * @param string $type
435 protected function feed( $type ) {
436 if ( !$this->getConfig()->get( 'Feed' ) ) {
437 $this->getOutput()->addWikiMsg( 'feed-unavailable' );
442 $feedClasses = $this->getConfig()->get( 'FeedClasses' );
443 if ( !isset( $feedClasses[$type] ) ) {
444 $this->getOutput()->addWikiMsg( 'feed-invalid' );
449 $feed = new $feedClasses[$type](
451 $this->msg( 'tagline' )->text(),
452 $this->getPageTitle()->getFullURL()
455 $pager = new NewPagesPager( $this, $this->opts
);
456 $limit = $this->opts
->getValue( 'limit' );
457 $pager->mLimit
= min( $limit, $this->getConfig()->get( 'FeedLimit' ) );
460 if ( $pager->getNumRows() > 0 ) {
461 foreach ( $pager->mResult
as $row ) {
462 $feed->outItem( $this->feedItem( $row ) );
468 protected function feedTitle() {
469 $desc = $this->getDescription();
470 $code = $this->getConfig()->get( 'LanguageCode' );
471 $sitename = $this->getConfig()->get( 'Sitename' );
473 return "$sitename - $desc [$code]";
476 protected function feedItem( $row ) {
477 $title = Title
::makeTitle( intval( $row->rc_namespace
), $row->rc_title
);
479 $date = $row->rc_timestamp
;
480 $comments = $title->getTalkPage()->getFullURL();
483 $title->getPrefixedText(),
484 $this->feedItemDesc( $row ),
485 $title->getFullURL(),
487 $this->feedItemAuthor( $row ),
495 protected function feedItemAuthor( $row ) {
496 return $row->rc_user_text ??
'';
499 protected function feedItemDesc( $row ) {
500 $revision = Revision
::newFromId( $row->rev_id
);
505 $content = $revision->getContent();
506 if ( $content === null ) {
510 // XXX: include content model/type in feed item?
511 return '<p>' . htmlspecialchars( $revision->getUserText() ) .
512 $this->msg( 'colon-separator' )->inContentLanguage()->escaped() .
513 htmlspecialchars( FeedItem
::stripComment( $revision->getComment() ) ) .
514 "</p>\n<hr />\n<div>" .
515 nl2br( htmlspecialchars( $content->serialize() ) ) . "</div>";
518 protected function getGroupName() {
522 protected function getCacheTTL() {